Skip to content

docs: README overhaul and Codecov/Dependabot setup#50

Merged
sgbett merged 7 commits intomasterfrom
feature/docs-readme-overhaul
Feb 10, 2026
Merged

docs: README overhaul and Codecov/Dependabot setup#50
sgbett merged 7 commits intomasterfrom
feature/docs-readme-overhaul

Conversation

@sgbett
Copy link
Copy Markdown
Owner

@sgbett sgbett commented Feb 10, 2026

Summary

  • README rewrite to match the structure shared by the official BSV SDKs (ts-sdk, go-sdk, py-sdk): welcome paragraph, table of contents, objectives, getting started with P2PKH example, features, contribution guidelines, support, and licence
  • Codecov integration: SimpleCov + simplecov-cobertura in Gemfile, gated behind COVERAGE env var, uploads from the Ruby 3.4 matrix job only
  • Badges: CI, Codecov, Gem Version, Ruby >= 2.7
  • Dependabot config for bundler and GitHub Actions (weekly)
  • TODO issues created for follow-up: Document bsv-attest gem and update README with link #48 (bsv-attest docs), Create SDK documentation #49 (SDK documentation)

Manual step

Add CODECOV_TOKEN as a GitHub Actions secret (from codecov.io) for coverage uploads to work.

Test plan

  • CI passes on all 6 Ruby versions
  • Coverage XML is generated on the 3.4 job
  • Codecov upload succeeds (after token is configured)
  • Dependabot starts raising PRs within a week
  • Badges render correctly on the README after merge

🤖 Generated with Claude Code

sgbett and others added 7 commits February 10, 2026 21:17
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add codecov, gem version, and ruby version badges. Adopt the shared
welcome paragraph and objectives from the reference SDKs. Add table
of contents, getting started with P2PKH example, features summary,
contribution guidelines, and support section.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 10, 2026

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment

Thanks for integrating Codecov - We've got you covered ☂️

@sgbett sgbett merged commit f079955 into master Feb 10, 2026
7 checks passed
@sgbett sgbett deleted the feature/docs-readme-overhaul branch February 10, 2026 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant